HTTP API репликаторов данных¶

В этом разделе приведен список HTTP-адресов, через которые выполняется взаимодействие с репликаторами данных.

TCF Gateway¶

Чтобы эндпоинты API api/v1/start, /api/v1/stop и другие были доступны для отправки HTTP-запросов, добавьте опцию gateway.http_server в файл конфигурации, который используется для настройки межкластерной репликации.

Пример конфигурации с включённым HTTP API:

gateway:
  # ...
  http_server:
    host: 192.168.64.9
    port: 10081

Пример всего файла конфигурации приведен в разделе Настройка репликаторов руководства пользователя. Полный список опций конфигурации Gateway можно найти в справочнике по конфигурации репликаторов данных.

Настройка TLS для HTTP-сервера¶

Доступно с версии 0.5.0.

HTTP-сервер, указанный в опции конфигурации gateway.http_server, обрабатывает входящие HTTP-запросы. Чтобы включить TLS-шифрование для этого сервера, необходимо указать в конфигурации сертификат и закрытый ключ.

Пример конфигурации с настроенным TLS:

gateway:
  http_server:
    host: 192.168.64.9
    port: 10081
    ssl_cert_file: "/path/to/the/cert/file"
    ssl_key_file: "/path/to/the/key/file"
    ssl_ca_file: "/path/to/the/ca/file"

ssl_cert_file – путь к файлу сертификата сервера, который используется для шифрования соединения между компонентами Gateway и Destination. Обязателен, если задан gateway.http_server.ssl_key_file;
ssl_key_file – путь к файлу закрытого ключа сервера, который соответствует сертификату из параметра gateway.http_server.ssl_cert_file. Используется для установки защищенного TLS-соединения. Обязателен, если задан gateway.http_server.ssl_cert_file;
ssl_ca_file – путь к файлу корневого сертификата, который используется для проверки подлинности клиента при установке TLS-соединения. Обрабатывается только в случае, если заданы gateway.http_server.ssl_cert_file и gateway.http_server.ssl_key_file. При их отсутствии возникает ошибка.

/metrics¶

GET /metrics

Получить метрики в формате prometheus. Включить метрики Gateway можно с помощью настройки конфигурации gateway.metrics_enabled.

Пример запроса:

$ curl -X GET --location "http://192.168.64.9:10081/metrics"

/api/v1/start¶

POST /api/v1/start

Запустить репликатор.

Пример запроса:

$ curl -X POST http://192.168.64.9:10081/api/v1/start

/api/v1/stop¶

POST /api/v1/stop

Приостановить репликатор.

Пример запроса:

$ curl -X POST http://192.168.64.9:10081/api/v1/stop

TCF Destination¶

Чтобы эндпоинты API были доступны для отправки HTTP-запросов, добавьте опцию destination.http_server в файл конфигурации, который используется для настройки межкластерной репликации.

Пример конфигурации с включённым HTTP API:

destination:
  http_server:
    host: 192.168.64.12
    port: 10082

Настройка TLS для HTTP-сервера¶

Доступно с версии 0.5.0.

HTTP-сервер, указанный в опции конфигурации destination.http_server, обрабатывает входящие HTTP-запросы. Чтобы включить TLS-шифрование для этого сервера, необходимо указать в конфигурации сертификат и закрытый ключ.

Пример конфигурации с настроенным TLS:

destination:
  http_server:
    host: 192.168.64.12
    port: 10082
    ssl_cert_file: "/path/to/the/cert/file"
    ssl_key_file: "/path/to/the/key/file"
    ssl_ca_file: "/path/to/the/ca/file"

ssl_cert_file – путь к файлу сертификата сервера, который используется для шифрования соединения между компонентами Gateway и Destination. Обязателен, если задан destination.http_server.ssl_key_file;
ssl_key_file – путь к файлу закрытого ключа сервера, который соответствует сертификату из параметра destination.http_server.ssl_cert_file. Используется для установки защищенного TLS-соединения. Обязателен, если задан destination.http_server.ssl_cert_file;
ssl_ca_file – путь к файлу корневого сертификата, который используется для проверки подлинности клиента при установке TLS-соединения. Обрабатывается только в случае, если заданы destination.http_server.ssl_cert_file и destination.http_server.ssl_key_file. При их отсутствии возникает ошибка.

/metrics¶

GET /metrics

Получить метрики в формате prometheus. Включить метрики Destination можно с помощью настройки конфигурации destination.metrics_enabled.

Пример запроса:

$ curl -X GET --location "http://192.168.64.12:10082/metrics"

/api/v1/status¶

GET /api/v1/status

Получить статус репликатора.

Пример запроса:

$ curl -X GET --location "http://192.168.64.12:10082/api/v1/status"

/api/v1/stop¶

POST /api/v1/stop

Приостановить репликатор.

Пример запроса:

$ curl -X POST --location "http://192.168.64.12:10082/api/v1/stop"

/api/v1/start¶

POST /api/v1/start

Запустить репликатор.

Пример запроса:

$ curl -X POST --location "http://192.168.64.12:10082/api/v1/start"

/api/v1/restart¶

POST /api/v1/restart

Перезапустить репликатор.

Пример запроса:

$ curl -X POST --location "http://192.168.64.12:10082/api/v1/restart"

/api/v1/rebootstrap¶

POST /api/v1/rebootstrap

Перезапустить репликатор с rebootstrap. Перезапуск репликатора может понадобиться в случае остановки репликации.

Пример запроса:

$ curl -X POST --location "http://192.168.64.12:10082/api/v1/rebootstrap"

Версия:

HTTP API репликаторов данных¶

TCF Gateway¶

Настройка TLS для HTTP-сервера¶

/metrics¶

/api/v1/start¶

/api/v1/stop¶

TCF Destination¶

Настройка TLS для HTTP-сервера¶

/metrics¶

/api/v1/status¶

/api/v1/stop¶

/api/v1/start¶

/api/v1/restart¶

/api/v1/rebootstrap¶